/*
 * Copyright 2013 Sigurd Randoll.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package de.digiway.rapidbreeze.client.infrastructure;

import de.digiway.rapidbreeze.client.model.collector.LinkBundle;

/**
 *
 * @author Sigurd
 */
public class BusEvents {

    /**
     * Will be fired if a connection to the server changes. The first and only
     * parameter is a boolean value representing the new connection state
     * (true=connected)
     */
    public static final String SERVER_CONNECTION_CHANGED_EVENT = "ServerConnectionChangedEvent";
    /**
     * Can be fired to open the "Download Collector" modal window:
     */
    public static final String OPEN_DOWNLOAD_COLLECTOR_WINDOW = "OpenDownloadCollectorWindow";
    /**
     * Can be fired to close the "Download Collector" modal window:
     */
    public static final String CLOSE_DOWNLOAD_COLLECTOR_WINDOW = "CloseDownloadCollectorWindow";
    /**
     * Adds a {@linkplain LinkBundle} to the download collector.
     * {@linkplain LinkBundle} is the first and only parameter of the bus event.
     */
    public static final String ADD_LINK_BUNDLE = "AddLinkBundle";
    /**
     * Will clear all downloads which have finished successfully.
     */
    public static final String CLEAR_FINISHED_DOWNLOADS = "ClearFinishedDownloads";
    /**
     * Will be fired if a property of the server configuration changes.
     */
    public static final String SERVER_CONFIGURATION_CHANGED_EVENT = "ServerConfigurationChangedEvent";
    /**
     * Fired on a menu item start action.
     */
    public static final String MENU_ITEM_START_EVENT = "MenuItemStartEvent";
    /**
     * Fired on a menu item pause action.
     */
    public static final String MENU_ITEM_PAUSE_EVENT = "MenuItemPauseEvent";
    /**
     * Fired on a menu item unpause action.
     */
    public static final String MENU_ITEM_UNPAUSE_EVENT = "MenuItemUnpauseEvent";
    /**
     * Fired on a menu item delete action.
     */
    public static final String MENU_ITEM_DELETE_EVENT = "MenuItemDeleteEvent";
    /**
     * Fired on a menu item delete all action.
     */
    public static final String MENU_ITEM_DELETE_ALL_EVENT = "MenuItemDeleteAllEvent";

    private BusEvents() {
    }
}
